/*******************************************************************************
 * This file is part of blueprint4j www.blueprint4j.org.
 * 
 *     blueprint4j is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * 
 *     blueprint4j is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 * 
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with blueprint4j. If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package blueprint4j.db;

import java.sql.ResultSet;
import java.sql.SQLException;

import blueprint4j.utils.BindStringBoxInterface;

public class FieldText extends Field implements BindStringBoxInterface {

	/**
	 * public Field( Text p_name, Text p_description, boolean p_key_field
	 *
	 * Name: Name of field -> equivalent to table.field_name
	 * Description: Description of field
	 * key_field: Is this field a key field in the table (index field)
	 */
	public FieldText(String p_name, int p_field_type ,String p_description,Entity entity ) {
		super( p_name,p_field_type,p_description,entity );
	}

	public Field newInstance(Entity entity) {
		return new FieldText(getName(),getFieldType(),getDescription(),entity);
	}

	protected void setFieldValue( ResultSet result_set )
	throws DataException {
		try {
			setObject(result_set.getString(getName()));
		} catch ( SQLException se ) {
			throw new DataException( "Can not retrieve '" + getName() + "'" );
		}
	}

	public String get() {
		if (getObject() == null) {
			return null;
		}
		return getObject().toString();
	}

	public String toString(){
		if (getObject() == null) {
			return null;
		}
		return getObject().toString();
	}

	public void set(String value){
		setObject(value);
	}
	
	public void set(Throwable value) {
		StackTraceElement[] trace=value.getStackTrace();
		StringBuffer sb=new StringBuffer();
		for (int t=0;t<trace.length;t++) {
			sb.append(trace[t].toString());
			sb.append("\n");
		}
		set(sb.toString());
	}

	public String getAsString() {
		return get();
	}
	
	public void setAsString(String value) {
		set(value);
	}
	
	/**
	 * Return data in a suitable SQL format
	 */
	public String getSQLValue()
	throws DataException {
		if (getObject() == null) {
			return "null";
		}
		return entity.getConnection().getDataBaseUtils().convertStringForSQL(get());
	}

	/**
	 * An overloaded equals method that only accepts the correct type
	 */
	public boolean equals(String value) {
		return get().equals(value);
	}
	
	public Object getPreparedStatementObject() 
	throws DataException {
		if (getObject() == null) return null;
		return get(); 
	}
}
